home *** CD-ROM | disk | FTP | other *** search
/ Aminet 1 (Walnut Creek) / Aminet - June 1993 [Walnut Creek].iso / aminet / text / misc / j2ag1_2.lha / J2AG.doc < prev   
Text File  |  1993-01-09  |  2KB  |  75 lines
  1.  
  2.    NAME
  3.     J2AG -- convert a Jargon file to the AmigaGuide ® format
  4.  
  5.    SYNOPSIS
  6.     J2AG infile outfile [VERBOSE]
  7.  
  8.    VERSION
  9.     1.2, 9-Jan-93 -- nu får det vara nog
  10.  
  11.    FUNCTION
  12.     This program converts a Jargon file to the AmigaGuide ® format
  13.     to make it easier to follow references to other entries while
  14.     reading.
  15.  
  16.     Those who don't know what the Jargon file is are encouraged to
  17.     find out. :)
  18.  
  19.    INPUTS
  20.     infile - a Jargon file, snatched from prep.ai.mit.edu or so...
  21.  
  22.    OUTPUTS
  23.     outfile - an AmigaGuide ® file, or something pretty much like one
  24.  
  25.     If the VERBOSE switch is used, J2AG barfs on stdout while converting
  26.     the file, reporting what it's currently doing.  After it's done, it
  27.     will display the number of nodes and valid xrefs that were found.
  28.  
  29.    REQUIREMENTS
  30.     * AmigaDOS Release 2 or better (utilizes V39 if present)
  31.  
  32.     * A copy of the Jargon file, or atleast something that looks like
  33.       one.
  34.  
  35.     * ~1.5M of contigous mem
  36.  
  37.    NOTE
  38.     The most recent version of the Jargon file is always available for
  39.     anonymous FTP from prep.ai.mit.edu in the directory /pub/gnu as
  40.     jargon<version>.tar.Z  (Current version as of 5th Jan 93 is 2.9.11)
  41.  
  42.     When run under V39, J2AG tries to set the buffer for the output
  43.     filehandle to 64k, using SetVBuf() to decrease disk thrashing.
  44.  
  45.     The program is unintentionally multitasking reentrant and pure,
  46.     since I accidentally linked with the wrong startup module.  Oh,
  47.     well...
  48.  
  49.     A ctrl-c usually makes J2AG abort the conversion and exit.
  50.  
  51.    BUGS
  52.     Some older versions of AmigaGuide ® do not like some chars (single
  53.     quotes, etc) in node titles, which can cause some references to
  54.     fail.  It is possible to escape them with a backslash, but in its
  55.     infinite wisdom, AmigaGuide ® displays the escape character too.
  56.  
  57.     Minimal checking is made to ensure that the input file follows the
  58.     Jargon file format.
  59.  
  60.    HISTORY
  61.     1.0    - first release
  62.     1.1    - minor bug with quotes in nodenames fixed
  63.     1.2    - fixed small bug with topic xrefs split over two lines
  64.         - improved formatting of xrefs
  65.         - reduced memory usage and added own pool allocation routine
  66.         - lots of other small improvements
  67.  
  68.    AUTHOR
  69.     Svante Eriksson (Flintlund)
  70.     Internet: d2ser@dtek.chalmers.se
  71.     FidoNet:  2:203/123.42
  72.  
  73.     Feedback/flames to one of the above e-mail addresses.
  74.  
  75.